docs: initial start of the maintainership docs under the bounty program #1894
+1,219
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WalkthroughThis change introduces a comprehensive documentation suite for the AsyncAPI Maintainership Program. It adds structured markdown files covering program overview, goals, contributor and mentor guides, evaluation processes, stipend and sponsorship details, communication protocols, and a code of conduct. The update establishes a dedicated, organized documentation section for the program. Changes
Sequence Diagram(s)sequenceDiagram
participant Contributor
participant Mentor
participant Organizer
participant OpenCollective
Organizer->>Contributor: Announce program & open applications
Contributor->>Organizer: Submit application
Organizer->>Mentor: Forward shortlisted applications
Mentor->>Organizer: Shortlist preferred contributors
Organizer->>Contributor: Notify acceptance/rejection
Contributor->>Mentor: Participate in bonding/contribution period
Mentor->>Contributor: Provide guidance and feedback
Note over Contributor,Mentor: Midterm Evaluation Period
Contributor->>Organizer: Submit evaluation form
Mentor->>Organizer: Submit evaluation form
Organizer->>Contributor: Notify pass/fail
Contributor->>OpenCollective: Request stipend (if passed)
Note over Contributor,Mentor: Final Evaluation Period
Contributor->>Organizer: Submit final evaluation
Mentor->>Organizer: Submit final evaluation
Organizer->>Contributor: Notify pass/fail
Contributor->>OpenCollective: Request final stipend (if passed)
Mentor->>OpenCollective: Request honorarium (if eligible)
Possibly related issues
Suggested labels
Suggested reviewers
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. Note ⚡️ Faster reviews with cachingCodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
12 tasks
|
@asyncapi/bounty_team |
2 tasks
…nto maintainership-docs
thulieblack
reviewed
May 27, 2025
|
|
||
| ## Prioritize Interest & Alignment | ||
|
|
||
| Some contributors may flock to a popular idea, while others apply without genuine interest or understanding. As a mentor, it’s important to identify applicants who truly resonate with the project. Look for passion, curiosity, and alignment with the project’s purpose. |
There was a problem hiding this comment.
Suggested change
| Some contributors may flock to a popular idea, while others apply without genuine interest or understanding. As a mentor, it’s important to identify applicants who truly resonate with the project. Look for passion, curiosity, and alignment with the project’s purpose. | |
| Some contributors may be drawn to a popular idea, while others apply without genuine interest or a proper understanding. As a mentor, it’s important to identify applicants who genuinely align with the project. Look for passion, curiosity, and alignment with the project’s purpose. |
thulieblack
reviewed
May 27, 2025
|
|
||
| ## Request a Contribution | ||
|
|
||
| If you find a candidate worthy of acceptance, ask contributors to submit a small, relevant contribution to your project. This serves as a practical skill check and helps you assess their familiarity with the stack, tooling, and codebase not just what they say in their application. |
There was a problem hiding this comment.
Suggested change
| If you find a candidate worthy of acceptance, ask contributors to submit a small, relevant contribution to your project. This serves as a practical skill check and helps you assess their familiarity with the stack, tooling, and codebase not just what they say in their application. | |
| If you find a candidate worthy of acceptance, ask contributors to submit a small, relevant contribution to your project. This serves as a practical skill check, helping you assess their familiarity with the stack, tooling, and codebase, not just what they say in their application. |
thulieblack
reviewed
May 27, 2025
| @@ -0,0 +1,51 @@ | |||
| --- | |||
| title: Mentors Roles And Responsibilty | |||
There was a problem hiding this comment.
Suggested change
| title: Mentors Roles And Responsibilty | |
| title: Mentors Roles and Responsibilities |
thulieblack
reviewed
May 27, 2025
|
|
||
| > _At AsyncAPI, we believe mentorship is one of the most effective ways to teach, upskill, and empower contributors in open source. When done right, it creates not just transformative learning experiences for contributors, but also long-lasting value and growth for mentors._ | ||
| Mentors are the foundation of the AsyncAPI Maintainership Program, without their expertise, guidance, and commitment, the program simply wouldn’t exist. They are not just technical experts; they are community members and leaders who embody the spirit of open collaboration. |
There was a problem hiding this comment.
Suggested change
| Mentors are the foundation of the AsyncAPI Maintainership Program, without their expertise, guidance, and commitment, the program simply wouldn’t exist. They are not just technical experts; they are community members and leaders who embody the spirit of open collaboration. | |
| Mentors are the foundation of the AsyncAPI Maintainership Program; without their expertise, guidance, and commitment, the program wouldn’t exist. They are not just technical experts; they are community members and leaders who embody the spirit of open collaboration. |
thulieblack
reviewed
May 27, 2025
| Mentors are the foundation of the AsyncAPI Maintainership Program, without their expertise, guidance, and commitment, the program simply wouldn’t exist. They are not just technical experts; they are community members and leaders who embody the spirit of open collaboration. | ||
|
|
||
| All AMP mentors are (or should be) trusted members of the AsyncAPI community and passionate advocates for open source. They bring deep knowledge of the ecosystem and a strong belief in the values of Free and Open Source Software (FOSS). |
There was a problem hiding this comment.
Suggested change
| All AMP mentors are (or should be) trusted members of the AsyncAPI community and passionate advocates for open source. They bring deep knowledge of the ecosystem and a strong belief in the values of Free and Open Source Software (FOSS). | |
| All AMP mentors are, or should be, trusted members of the AsyncAPI community and passionate advocates for open source. They possess deep knowledge of the ecosystem and a strong commitment to the values of Free and Open Source Software (FOSS). |
thulieblack
reviewed
May 27, 2025
|
|
||
| All AMP mentors are (or should be) trusted members of the AsyncAPI community and passionate advocates for open source. They bring deep knowledge of the ecosystem and a strong belief in the values of Free and Open Source Software (FOSS). | ||
|
|
||
| Mentors role goes beyond just technical guidance — mentors help shape a culture of inclusion, sustainability, and authentic contribution in open source. |
There was a problem hiding this comment.
Suggested change
| Mentors role goes beyond just technical guidance — mentors help shape a culture of inclusion, sustainability, and authentic contribution in open source. | |
| Mentors' role goes beyond just technical guidance; they help shape a culture of inclusion, sustainability, and authentic contribution in open source. |
thulieblack
reviewed
May 27, 2025
| Below are the key responsibilities and expectations for mentors: | ||
| ## Project Planning | ||
|
|
||
| - Define a clear project scope with achievable, measurable goals. |
There was a problem hiding this comment.
Suggested change
| - Define a clear project scope with achievable, measurable goals. | |
| - Define a clear project scope with achievable and measurable goals. |
thulieblack
reviewed
May 27, 2025
|
|
||
| - Define a clear project scope with achievable, measurable goals. | ||
| - Break the project into milestones that align with the program timeline. | ||
| - Prepare a list of actionable tasks/issues for contributors to work on. |
There was a problem hiding this comment.
Suggested change
| - Prepare a list of actionable tasks/issues for contributors to work on. | |
| - Prepare a list of actionable tasks or issues for contributors to work on. |
thulieblack
reviewed
May 27, 2025
| ## Contributor Onboarding | ||
|
|
||
| - Create a welcoming, inclusive, and supportive space for learning. | ||
| - Provide a clear introduction to the project — including codebase structure, contribution guidelines, and documentation. |
There was a problem hiding this comment.
Suggested change
| - Provide a clear introduction to the project — including codebase structure, contribution guidelines, and documentation. | |
| - Provide a clear introduction to the project, including codebase structure, contribution guidelines, and documentation. |
thulieblack
reviewed
May 27, 2025
| - Be inclusive, empathetic, and open to feedback from contributors. | ||
| - Proactively support contributors through blockers or challenges. | ||
| - Responsiveness towards contributors challenges and blockers | ||
| - Check-in on the mentee periodically (especially if there has been no recent contact from mentee) |
There was a problem hiding this comment.
Suggested change
| - Check-in on the mentee periodically (especially if there has been no recent contact from mentee) | |
| - Check in on the mentee periodically (especially if there has been no recent contact from the mentee) |
thulieblack
reviewed
May 27, 2025
| - Proactively support contributors through blockers or challenges. | ||
| - Responsiveness towards contributors challenges and blockers | ||
| - Check-in on the mentee periodically (especially if there has been no recent contact from mentee) | ||
| - Follow up periodically, especially if a contributor goes silent — to re-engage and offer support. |
There was a problem hiding this comment.
Suggested change
| - Follow up periodically, especially if a contributor goes silent — to re-engage and offer support. | |
| - Follow up periodically, especially if a contributor goes silent, to re-engage and offer support. |
thulieblack
reviewed
May 27, 2025
|
|
||
| - Track contributor progress consistently throughout the program. | ||
| - Complete mid-term and final evaluations with honest, constructive feedback. | ||
| - Nominate exceptional contributors for community shout-outs and potential future roles (e.g., triager, maintainer). |
There was a problem hiding this comment.
Suggested change
| - Nominate exceptional contributors for community shout-outs and potential future roles (e.g., triager, maintainer). | |
| - Nominate exceptional contributors for community shout-outs and potential future roles, such as triagers and maintainers. |
thulieblack
reviewed
May 27, 2025
| - Complete mid-term and final evaluations with honest, constructive feedback. | ||
| - Nominate exceptional contributors for community shout-outs and potential future roles (e.g., triager, maintainer). | ||
|
|
||
| > Suppose AsyncAPI reasonably believes that a Mentor still needs to meet the primary responsibilities. In that case, AsyncAPI may require the Progam Administrators to designate a replacement Mentor and remove the former Mentor from the Program. |
There was a problem hiding this comment.
Suggested change
| > Suppose AsyncAPI reasonably believes that a Mentor still needs to meet the primary responsibilities. In that case, AsyncAPI may require the Progam Administrators to designate a replacement Mentor and remove the former Mentor from the Program. | |
| > Suppose AsyncAPI reasonably believes that a Mentor still needs to meet the primary responsibilities. In that case, AsyncAPI may require the Program Administrators to designate a replacement Mentor and remove the former Mentor from the Program. |
thulieblack
reviewed
May 27, 2025
| @@ -0,0 +1,37 @@ | |||
| --- | |||
| title: Support And Escalation Path | |||
There was a problem hiding this comment.
Suggested change
| title: Support And Escalation Path | |
| title: Support and Escalation Path |
thulieblack
reviewed
May 27, 2025
| weight: 70 | ||
| --- | ||
|
|
||
| Mentorship is a rewarding but often demanding journey. At AsyncAPI, we understand that challenges can arise, whether it's dealing with unresponsive contributors, managing conflicting schedules, or navigating tough feedback moments. That’s why we’ve built a support system to help you handle these situations with clarity, and care. |
There was a problem hiding this comment.
Suggested change
| Mentorship is a rewarding but often demanding journey. At AsyncAPI, we understand that challenges can arise, whether it's dealing with unresponsive contributors, managing conflicting schedules, or navigating tough feedback moments. That’s why we’ve built a support system to help you handle these situations with clarity, and care. | |
| Mentorship is a rewarding but often demanding journey. At AsyncAPI, we understand that challenges can arise, whether it's dealing with unresponsive contributors, managing conflicting schedules, or navigating tough feedback moments. That’s why we’ve built a support system to help you handle these situations with clarity and care. |
thulieblack
reviewed
May 27, 2025
|
|
||
| ### 3. **Conflict Resolution Path** | ||
|
|
||
| - If you face interpersonal challenges, such as an uncooperative/non-chalant contributor or community conflicts, escalate early: |
There was a problem hiding this comment.
Suggested change
| - If you face interpersonal challenges, such as an uncooperative/non-chalant contributor or community conflicts, escalate early: | |
| - If you face interpersonal challenges, such as an uncooperative/nonchalant contributor or community conflicts, escalate early: |
thulieblack
reviewed
May 27, 2025
|
|
||
| - If you face interpersonal challenges, such as an uncooperative/non-chalant contributor or community conflicts, escalate early: | ||
| - First, attempt a private conversation with the mentee, framed around constructive feedback. | ||
| - If unresolved, report the issue to the program organizers via Slack DM or email. |
There was a problem hiding this comment.
Suggested change
| - If unresolved, report the issue to the program organizers via Slack DM or email. | |
| - If the issue remains unresolved, report it to the program organizers via Slack DM or email. |
thulieblack
reviewed
May 27, 2025
|
|
||
| - If a contributor is showing signs of non-commitment during the program phase: | ||
| - Reach out to the contributor privately to understand the reason for no commitment. | ||
| - If there's no response within a week, kindly inform the program organizers as soon as possible. |
There was a problem hiding this comment.
Suggested change
| - If there's no response within a week, kindly inform the program organizers as soon as possible. | |
| - If there is no response within a week, please inform the program organizers as soon as possible. |
thulieblack
reviewed
May 27, 2025
|
|
||
| If a contributor or mentor hasn’t submitted their evaluation within the **first 3 days** of the evaluation period, organizers will follow up via **Slack DM** to check in. This gives us time to understand any blockers, provide support, and take action where necessary to keep the program on track. | ||
|
|
||
| >_We strongly encourage all contributors and mentors to make this a priority. If you’re unclear on any part of the process, please contact the program organizers as early as possible. |
There was a problem hiding this comment.
Suggested change
| >_We strongly encourage all contributors and mentors to make this a priority. If you’re unclear on any part of the process, please contact the program organizers as early as possible. | |
| >_We strongly encourage all contributors and mentors to make this a priority. If you’re unclear on any part of the process, please get in touch with the program organizers as early as possible. |
thulieblack
reviewed
May 27, 2025
| weight: 60 | ||
| --- | ||
|
|
||
| Evaluations occur twice during the program duration: at the **midpoint** of the program and the **end** of the program after you submit your final work. Evaluation periods varies for different project and are determined based on project complexity. For a standard 12 weeks project your first evaluation will be at the end of the 6th week and the final evaluation will be after the 12th week of the contributing period. |
There was a problem hiding this comment.
Suggested change
| Evaluations occur twice during the program duration: at the **midpoint** of the program and the **end** of the program after you submit your final work. Evaluation periods varies for different project and are determined based on project complexity. For a standard 12 weeks project your first evaluation will be at the end of the 6th week and the final evaluation will be after the 12th week of the contributing period. | |
| Evaluations occur twice during the program duration: at the **midpoint** of the program and the **end** of the program after you submit your final work. Evaluation periods vary for different projects and are determined based on project complexity. For a standard 12-week project, your first evaluation will be at the end of the 6th week, and the final evaluation will be after the 12th week of the contributing period. |
thulieblack
reviewed
May 27, 2025
|
|
||
| Evaluations occur twice during the program duration: at the **midpoint** of the program and the **end** of the program after you submit your final work. Evaluation periods varies for different project and are determined based on project complexity. For a standard 12 weeks project your first evaluation will be at the end of the 6th week and the final evaluation will be after the 12th week of the contributing period. | ||
|
|
||
| The evaluations are opportunities for both mentors and contributors to evaluate each other and also the program organizers performance. |
There was a problem hiding this comment.
Why are the program organizers' performance being evaluated?
thulieblack
reviewed
May 27, 2025
|
|
||
| ## How Evaluations Work | ||
|
|
||
| Evaluations are a survey that both mentor and contributor fill during the evaluation period. Program organizers have this evaluations questions for both contributor and mentor in advance in the form of a **Google Form**. |
There was a problem hiding this comment.
Suggested change
| Evaluations are a survey that both mentor and contributor fill during the evaluation period. Program organizers have this evaluations questions for both contributor and mentor in advance in the form of a **Google Form**. | |
| Evaluations are a survey that both the mentor and the contributor fill out during the evaluation period. Program organizers have these evaluation questions for both the contributor and the mentor in advance in the form of a **Google Form**. |
thulieblack
reviewed
May 27, 2025
|
|
||
| >_Submitting your evaluation is **mandatory**. Failure to complete it during any phase will result in immediate removal from the program and loss of stipend eligibility._ | ||
|
|
||
| Organizers will keep evaluation responses **confidential**, except for specific “Feedback for Mentor” or “Feedback for Contributor” sections, which will be shared accordingly. In rare cases, such as if a contributor fails — more detailed feedback may be disclosed to mentors to ensure transparency around stipend decisions. |
There was a problem hiding this comment.
Suggested change
| Organizers will keep evaluation responses **confidential**, except for specific “Feedback for Mentor” or “Feedback for Contributor” sections, which will be shared accordingly. In rare cases, such as if a contributor fails — more detailed feedback may be disclosed to mentors to ensure transparency around stipend decisions. | |
| Organizers will keep evaluation responses **confidential**, except for specific “Feedback for Mentor” or “Feedback for Contributor” sections, which will be shared accordingly. In rare cases, such as if a contributor fails, more detailed feedback may be disclosed to mentors to ensure transparency around stipend decisions. |
thulieblack
reviewed
May 27, 2025
| - Any unfinished tasks | ||
| - Plans for continued contribution | ||
|
|
||
| For projects with multiple contributors, which falls under only **documentation-related project ideas**, stipends are disbursed **only after final evaluations** are completed. This is because: |
There was a problem hiding this comment.
Based on the past experiences and feedback from 2024 mentors, all stipends should be disbursed once the contributor is done unless in wrong on this? regardless of being docs design or code
thulieblack
reviewed
May 27, 2025
| @@ -0,0 +1,62 @@ | |||
| --- | |||
| title: How to Secure Sponsorship | |||
| description: This overview page outlines the how to be a sponsor/partner in the maintainership program | |||
There was a problem hiding this comment.
Suggested change
| description: This overview page outlines the how to be a sponsor/partner in the maintainership program | |
| description: This overview page outlines how to be a sponsor/partner in the maintainership program |
thulieblack
reviewed
May 27, 2025
| ### For Individuals | ||
|
|
||
| **One-Time or Recurring Donations:** | ||
| Every contribution, big or small directly supports contributor stipends and mentor honorariums. Your support helps make open source mentorship more accessible and equitable. |
There was a problem hiding this comment.
Suggested change
| Every contribution, big or small directly supports contributor stipends and mentor honorariums. Your support helps make open source mentorship more accessible and equitable. | |
| Every contribution, big or small, directly supports contributor stipends and mentor honorariums. Your support helps make open source mentorship more accessible and equitable. |
thulieblack
reviewed
May 27, 2025
| **Sponsor via Open Collective:** Visit our AsyncAPI Open Collective and select the Maintainership Program fund. | ||
|
|
||
|
|
||
| Sponsorship isn’t just a transaction, it’s an investment in people, purpose, and the future of open source. Thank you for considering joining us on this journey. |
There was a problem hiding this comment.
Suggested change
| Sponsorship isn’t just a transaction, it’s an investment in people, purpose, and the future of open source. Thank you for considering joining us on this journey. | |
| Sponsorship isn’t just a transaction; it’s an investment in people, purpose, and the future of open source. Thank you for considering joining us on this journey. |
thulieblack
reviewed
May 27, 2025
|
|
||
| - **Operations & Infrastructure:** Sponsorship supports coordination, onboarding resources, platform tooling, and post-program recognition. | ||
|
|
||
| - **Global & Inclusive Participation:** With your support, we can reach underrepresented and underserved contributors across the globe—breaking down financial and geographic barriers. |
There was a problem hiding this comment.
Suggested change
| - **Global & Inclusive Participation:** With your support, we can reach underrepresented and underserved contributors across the globe—breaking down financial and geographic barriers. | |
| - **Global & Inclusive Participation:** With your support, we can reach underrepresented and underserved contributors across the globe, breaking down financial and geographic barriers., |
thulieblack
requested changes
May 27, 2025
There was a problem hiding this comment.
Thank you, @AceTheCreator, for the initial documents.
Here are my suggestions for improvement:
- Please combine some of the documents into one, as I mentioned in my review.
- Reorganize your folder structure properly. It is difficult to navigate when everything is under one folder labeled 'general-information' instead of 'maintainership-guide.'
- Some of the documents do not align with the community's goals. For instance, the project submission documents should emphasize why maintainers and mentors should submit maintainership projects, rather than just regular projects. This needs to be explained clearly.
- In the Payment and Disbursement document, shouldn't all mentees receive a stipend after passing the first and second evaluations? I am basing this on feedback from mentors and past experiences.
- I am missing a section that states contributors must have made solid contributions to the community for 4-6 months to qualify for maintainership. Remember, this is not only about mentorship or GSoC but specifically about maintainership.
- Mentee selection will depend on the contributor's participation in the community over the months; therefore, it is essential to highlight this.
- For the mentors, please add a requirement that they attend a mandatory meeting before the program begins, so they are aware of the expectations. And have a mentor and organizer Q&A.
Each folder should contain a minimum of 3-4 documents, so try to consolidate them. Also, please ensure that there is alignment between the documentation and the community goals for Maintainership.
|
Looking forward to round 2! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request is part of the ongoing initiative to document the AsyncAPI Mentorship Program under the AsyncAPI Bounty Program. The goal of this documentation is to provide a comprehensive and accessible guide for both new and returning mentors and contributors, outlining the structure, expectations, and best practices for participating in the program.
By documenting our learnings and processes, we aim to support future maintainership cycles with effortless program onboarding, and improve the overall experience for everyone involved from contributors and mentors to program organizers.
Summary by CodeRabbit